Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style(repo): Introducing markdown file lintting #1587

Merged
merged 3 commits into from
Sep 6, 2024
Merged

Conversation

literat
Copy link
Collaborator

@literat literat commented Aug 22, 2024

Description

Using our new Remark Config for linting our Markdown files.

Applied fixes:

  • Unexpected heading with equivalent text, expected unique headings
  • Unexpected unused definition, expected no definition or one or more references, e.g. missing or bad links
  • Unexpected shortcut reference link ([text]), expected collapsed reference ([text][])
  • Unexpected character : at end of heading, remove it
  • Unexpected missing fenced code language flag in info string, expected keyword
  • Last content defined here
  • Unexpected definition before last content, expected definitions after line
  • Unexpected heading rank 3, exected rank 2
  • Heading capitalization error.

Only for the web package and main repo files. Trying to keep this PR small as possible.

Additional context

https://github.com/lmc-eu/code-quality-tools/tree/main/packages/remark-config

Issue reference

Copy link

netlify bot commented Aug 22, 2024

Deploy Preview for spirit-design-system ready!

Name Link
🔨 Latest commit 812e1d6
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system/deploys/66db2106f7e82a00077f03d3
😎 Deploy Preview https://deploy-preview-1587--spirit-design-system.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 96 (no change from production)
Accessibility: 93 (no change from production)
Best Practices: 100 (no change from production)
SEO: 82 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Aug 22, 2024

Deploy Preview for spirit-design-system-storybook canceled.

Name Link
🔨 Latest commit 812e1d6
🔍 Latest deploy log https://app.netlify.com/sites/spirit-design-system-storybook/deploys/66db2106b22f2f0008d341b9

@coveralls
Copy link

coveralls commented Aug 22, 2024

Coverage Status

coverage: 73.281% (-5.4%) from 78.698%
when pulling 812e1d6 on style/markdown-linting
into 8274478 on main.

@literat literat force-pushed the style/markdown-linting branch 3 times, most recently from 4eb0799 to d562929 Compare August 28, 2024 11:38
@literat literat marked this pull request as ready for review August 28, 2024 12:44
Copy link
Member

@crishpeen crishpeen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great! Looking forward to have this everywhere.

.remarkignore Show resolved Hide resolved
DEPRECATIONS-v3.md Outdated Show resolved Hide resolved
packages/web/src/scss/components/Accordion/README.md Outdated Show resolved Hide resolved
packages/web/src/scss/components/FileUploader/README.md Outdated Show resolved Hide resolved
packages/web/src/scss/components/Header/README.md Outdated Show resolved Hide resolved
packages/web/src/scss/components/Radio/README.md Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
@literat literat requested a review from crishpeen August 29, 2024 15:06
@literat literat force-pushed the style/markdown-linting branch from 5dfd301 to 812e1d6 Compare September 6, 2024 15:34
@literat literat merged commit 497de39 into main Sep 6, 2024
21 checks passed
@literat literat deleted the style/markdown-linting branch September 6, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants